<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
<meta content="User,com.digitalflipbook.webapis.scribd.methodgroups.User,login,signup" name="keywords">
<title>com.digitalflipbook.webapis.scribd.methodgroups.User</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'User - DigitalFlipbook ActionScript 3.0 Library - as3scribdlib';
				var baseRef = '../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?com/digitalflipbook/webapis/scribd/methodgroups/User.html&amp;com/digitalflipbook/webapis/scribd/methodgroups/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;User</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class User"); titleBar_setSubNav(false,false,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.digitalflipbook.webapis.scribd.methodgroups</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class User</td>
</tr>
</table>
<p></p>
<p></p>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#User()">User</a>(service:<a href="../ScribdService.html">ScribdService</a>)</div>
<div class="summaryTableDescription"></div>
</td><td class="summaryTableOwnerCol">User</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#login()">login</a>(username:String, password:String):void</div>
<div class="summaryTableDescription">
   This method allows your API application to sign in as an existing Scribd user, executing methods as that user.</div>
</td><td class="summaryTableOwnerCol">User</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#signup()">signup</a>(username:String, password:String, email:String, name:String = null):void</div>
<div class="summaryTableDescription">
   This method allows your API application to signup a new Scribd user.</div>
</td><td class="summaryTableOwnerCol">User</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:login">login</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the login method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "user_login_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">User</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:signup">signup</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Broadcast as a result of the signup method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "user_signup_response" string
      When success is false, contains an "error" ScribdError instance
    </td><td class="summaryTableOwnerCol">User</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="User()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">User</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function User(service:<a href="../ScribdService.html">ScribdService</a>)</code><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">service</span>:<a href="../ScribdService.html">ScribdService</a></code></td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="login()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">login</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function login(username:String, password:String):void</code><p>
   This method allows your API application to sign in as an existing Scribd user, executing methods as that user.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">username</span>:String</code> &mdash; The username of the user to login.
       The API actually handles this parameter flexibly, and will accept an email address instead of a username.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">password</span>:String</code> &mdash; The password for the user account.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=user.login" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=user.login</a>
</div>
</div>
<a name="signup()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">signup</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function signup(username:String, password:String, email:String, name:String = null):void</code><p>
   This method allows your API application to signup a new Scribd user.
   If the signup is successful, your application will be passed back a session key which will allow you to execute methods on behalf of the new user.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">username</span>:String</code> &mdash; The username of the user to signup.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">password</span>:String</code> &mdash; The password for the new user account.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">email</span>:String</code> &mdash; The email address of the user. Please ensure that this address is valid to comply with US Copyright Law.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">name</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The real name of the user.
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://www.scribd.com/platform/documentation/api?method_name=user.login" target="mm_external">http://www.scribd.com/platform/documentation/api?method_name=user.login</a>
</div>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:login"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">login</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.USER_LOGIN</code></a>
<br>
<p></p><p>
  Broadcast as a result of the login method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "user_login_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/User.html#login" target="">login</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<a name="event:signup"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">signup</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>com.digitalflipbook.webapis.scribd.events.ScribdResultEvent.USER_SIGNUP</code></a>
<br>
<p></p><p>
  Broadcast as a result of the signup method being called
    The event contains the following properties
  success - Boolean indicating if the call was successful or not
  data - When success is true, contains a "user_signup_response" string
      When success is false, contains an "error" ScribdError instance
    </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../methodgroups/User.html#signup" target="">signup</a>
<br>com.digitalflipbook.service.scribd.ScribdError</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
